<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    <a name="line.1"></a>
<FONT color="green">002</FONT>    /*<a name="line.2"></a>
<FONT color="green">003</FONT>     * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<FONT color="green">004</FONT>     *<a name="line.4"></a>
<FONT color="green">005</FONT>     * $Id: SQLDatabaseAction.html 44 2011-02-20 21:57:32Z archie.cobbs $<a name="line.5"></a>
<FONT color="green">006</FONT>     */<a name="line.6"></a>
<FONT color="green">007</FONT>    <a name="line.7"></a>
<FONT color="green">008</FONT>    package org.dellroad.stuff.schema;<a name="line.8"></a>
<FONT color="green">009</FONT>    <a name="line.9"></a>
<FONT color="green">010</FONT>    import java.sql.Connection;<a name="line.10"></a>
<FONT color="green">011</FONT>    import java.sql.SQLException;<a name="line.11"></a>
<FONT color="green">012</FONT>    import java.sql.Statement;<a name="line.12"></a>
<FONT color="green">013</FONT>    import java.util.regex.Pattern;<a name="line.13"></a>
<FONT color="green">014</FONT>    <a name="line.14"></a>
<FONT color="green">015</FONT>    import org.slf4j.Logger;<a name="line.15"></a>
<FONT color="green">016</FONT>    import org.slf4j.LoggerFactory;<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    /**<a name="line.18"></a>
<FONT color="green">019</FONT>     * A {@link DatabaseAction} that executes a configured SQL script.<a name="line.19"></a>
<FONT color="green">020</FONT>     *<a name="line.20"></a>
<FONT color="green">021</FONT>     * &lt;p&gt;<a name="line.21"></a>
<FONT color="green">022</FONT>     * The script may contain multiple SQL statements, in which case individual statements will be parsed out and<a name="line.22"></a>
<FONT color="green">023</FONT>     * executed individually in order. However, this requires proper configuration of the {@link #setSplitPattern split pattern}.<a name="line.23"></a>
<FONT color="green">024</FONT>     *<a name="line.24"></a>
<FONT color="green">025</FONT>     * &lt;p&gt;<a name="line.25"></a>
<FONT color="green">026</FONT>     * When using Spring, beans of this type can be created succintly using the &lt;code&gt;&amp;lt;dellroad-stuff:sql&amp;gt;&lt;/code&gt; custom<a name="line.26"></a>
<FONT color="green">027</FONT>     * XML element. The split pattern may be configured via the {@code split-pattern} attribute, and the SQL script is specified<a name="line.27"></a>
<FONT color="green">028</FONT>     * either directly via inline text or using the {@code resource} attribute. In the latter case, the character encoding can<a name="line.28"></a>
<FONT color="green">029</FONT>     * specified via the {@code charset} attribute (default is {@code "UTF-8"}).<a name="line.29"></a>
<FONT color="green">030</FONT>     *<a name="line.30"></a>
<FONT color="green">031</FONT>     * &lt;p&gt;<a name="line.31"></a>
<FONT color="green">032</FONT>     * For example:<a name="line.32"></a>
<FONT color="green">033</FONT>     * &lt;blockquote&gt;&lt;pre&gt;<a name="line.33"></a>
<FONT color="green">034</FONT>     *  &amp;lt;beans xmlns="http://www.springframework.org/schema/beans"<a name="line.34"></a>
<FONT color="green">035</FONT>     *    &lt;b&gt;xmlns:dellroad-stuff="http://dellroad-stuff.googlecode.com/schema/dellroad-stuff"&lt;/b&gt;<a name="line.35"></a>
<FONT color="green">036</FONT>     *    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"<a name="line.36"></a>
<FONT color="green">037</FONT>     *    xsi:schemaLocation="<a name="line.37"></a>
<FONT color="green">038</FONT>     *      http://www.springframework.org/schema/beans<a name="line.38"></a>
<FONT color="green">039</FONT>     *        http://www.springframework.org/schema/beans/spring-beans-3.0.xsd<a name="line.39"></a>
<FONT color="green">040</FONT>     *      &lt;b&gt;http://dellroad-stuff.googlecode.com/schema/dellroad-stuff<a name="line.40"></a>
<FONT color="green">041</FONT>     *        http://dellroad-stuff.googlecode.com/svn/wiki/schemas/dellroad-stuff-1.0.xsd&lt;/b&gt;"&amp;gt;<a name="line.41"></a>
<FONT color="green">042</FONT>     *<a name="line.42"></a>
<FONT color="green">043</FONT>     *      &amp;lt;!-- SQL action that clears the audit log --&amp;gt;<a name="line.43"></a>
<FONT color="green">044</FONT>     *      &lt;b&gt;&amp;lt;dellroad-stuff:sql&amp;gt;DELETE * FROM AUDIT_LOG&amp;lt;/dellroad-stuff:sql&amp;gt;&lt;/b&gt;<a name="line.44"></a>
<FONT color="green">045</FONT>     *<a name="line.45"></a>
<FONT color="green">046</FONT>     *      &amp;lt;!-- A more complicated external SQL script --&amp;gt;<a name="line.46"></a>
<FONT color="green">047</FONT>     *      &lt;b&gt;&amp;lt;dellroad-stuff:sql resource="classpath:reset.sql" split-pattern=";\n"/&amp;gt;&lt;/b&gt;<a name="line.47"></a>
<FONT color="green">048</FONT>     *<a name="line.48"></a>
<FONT color="green">049</FONT>     *      &amp;lt;!-- other beans... --&amp;gt;<a name="line.49"></a>
<FONT color="green">050</FONT>     *<a name="line.50"></a>
<FONT color="green">051</FONT>     *  &amp;lt;/beans&amp;gt;<a name="line.51"></a>
<FONT color="green">052</FONT>     * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.52"></a>
<FONT color="green">053</FONT>     */<a name="line.53"></a>
<FONT color="green">054</FONT>    public class SQLDatabaseAction implements DatabaseAction {<a name="line.54"></a>
<FONT color="green">055</FONT>    <a name="line.55"></a>
<FONT color="green">056</FONT>        /**<a name="line.56"></a>
<FONT color="green">057</FONT>         * The default split pattern: &lt;code&gt;{@value}&lt;/code&gt;.<a name="line.57"></a>
<FONT color="green">058</FONT>         */<a name="line.58"></a>
<FONT color="green">059</FONT>        public static final String DEFAULT_SPLIT_PATTERN = ";[ \\t\\r]*\\n\\s*";<a name="line.59"></a>
<FONT color="green">060</FONT>    <a name="line.60"></a>
<FONT color="green">061</FONT>        protected final Logger log = LoggerFactory.getLogger(getClass());<a name="line.61"></a>
<FONT color="green">062</FONT>    <a name="line.62"></a>
<FONT color="green">063</FONT>        private String sqlScript;<a name="line.63"></a>
<FONT color="green">064</FONT>        private String splitPattern = DEFAULT_SPLIT_PATTERN;<a name="line.64"></a>
<FONT color="green">065</FONT>    <a name="line.65"></a>
<FONT color="green">066</FONT>        /**<a name="line.66"></a>
<FONT color="green">067</FONT>         * Configure the SQL script. This is a required property.<a name="line.67"></a>
<FONT color="green">068</FONT>         *<a name="line.68"></a>
<FONT color="green">069</FONT>         * &lt;p&gt;<a name="line.69"></a>
<FONT color="green">070</FONT>         * For scripts in external resources, consider {@link org.dellroad.stuff.spring.ResourceReaderFactoryBean}<a name="line.70"></a>
<FONT color="green">071</FONT>         * or use the &lt;code&gt;&amp;lt;dellroad-stuff:sql&amp;gt;&lt;/code&gt; element.<a name="line.71"></a>
<FONT color="green">072</FONT>         *<a name="line.72"></a>
<FONT color="green">073</FONT>         * @param sqlScript script containing one or more SQL statements; if more than one statement is present,<a name="line.73"></a>
<FONT color="green">074</FONT>         *  a {@link #setSplitPattern split pattern} must also be configured<a name="line.74"></a>
<FONT color="green">075</FONT>         * @see #setSplitPattern setSplitPattern()<a name="line.75"></a>
<FONT color="green">076</FONT>         */<a name="line.76"></a>
<FONT color="green">077</FONT>        public void setSQLScript(String sqlScript) {<a name="line.77"></a>
<FONT color="green">078</FONT>            this.sqlScript = sqlScript;<a name="line.78"></a>
<FONT color="green">079</FONT>        }<a name="line.79"></a>
<FONT color="green">080</FONT>    <a name="line.80"></a>
<FONT color="green">081</FONT>        /**<a name="line.81"></a>
<FONT color="green">082</FONT>         * Set the &lt;i&gt;split pattern&lt;/i&gt; used to split apart a script containing multiple SQL statements into individual statements.<a name="line.82"></a>
<FONT color="green">083</FONT>         *<a name="line.83"></a>
<FONT color="green">084</FONT>         * &lt;p&gt;<a name="line.84"></a>
<FONT color="green">085</FONT>         * The default value for this property is &lt;code&gt;";[ \t\r]*\n\s*"&lt;/code&gt;, which should handle cases where<a name="line.85"></a>
<FONT color="green">086</FONT>         * SQL statements are terminated by semi-colons and each SQL statement starts on a new line.<a name="line.86"></a>
<FONT color="green">087</FONT>         *<a name="line.87"></a>
<FONT color="green">088</FONT>         * &lt;p&gt;<a name="line.88"></a>
<FONT color="green">089</FONT>         * If this is set to {@code null}, or the script does not contain any instances of the regular expression,<a name="line.89"></a>
<FONT color="green">090</FONT>         * the script is assumed to contain a single SQL statement. SQL statements are whitespace-trimmed and any<a name="line.90"></a>
<FONT color="green">091</FONT>         * "statements" that consist entirely of whitespace are ignored.<a name="line.91"></a>
<FONT color="green">092</FONT>         *<a name="line.92"></a>
<FONT color="green">093</FONT>         * @throws java.util.regex.PatternSyntaxException if the pattern is not a valid Java regular expression<a name="line.93"></a>
<FONT color="green">094</FONT>         */<a name="line.94"></a>
<FONT color="green">095</FONT>        public void setSplitPattern(String splitPattern) {<a name="line.95"></a>
<FONT color="green">096</FONT>            if (splitPattern != null)<a name="line.96"></a>
<FONT color="green">097</FONT>                Pattern.compile(splitPattern);<a name="line.97"></a>
<FONT color="green">098</FONT>            this.splitPattern = splitPattern;<a name="line.98"></a>
<FONT color="green">099</FONT>        }<a name="line.99"></a>
<FONT color="green">100</FONT>    <a name="line.100"></a>
<FONT color="green">101</FONT>        @Override<a name="line.101"></a>
<FONT color="green">102</FONT>        public void apply(Connection c) throws SQLException {<a name="line.102"></a>
<FONT color="green">103</FONT>            if (this.sqlScript == null)<a name="line.103"></a>
<FONT color="green">104</FONT>                throw new IllegalArgumentException("no SQL script configured");<a name="line.104"></a>
<FONT color="green">105</FONT>            String[] statements = this.splitPattern != null ? this.sqlScript.split(this.splitPattern) : new String[] { this.sqlScript };<a name="line.105"></a>
<FONT color="green">106</FONT>            for (int i = 0; i &lt; statements.length; i++) {<a name="line.106"></a>
<FONT color="green">107</FONT>                String sql = statements[i].trim();<a name="line.107"></a>
<FONT color="green">108</FONT>                if (sql.length() == 0)<a name="line.108"></a>
<FONT color="green">109</FONT>                    continue;<a name="line.109"></a>
<FONT color="green">110</FONT>                String sep = sql.indexOf('\n') != -1 ? "\n" : " ";<a name="line.110"></a>
<FONT color="green">111</FONT>                this.log.info("executing SQL statement:" + sep + sql);<a name="line.111"></a>
<FONT color="green">112</FONT>                Statement statement = c.createStatement();<a name="line.112"></a>
<FONT color="green">113</FONT>                try {<a name="line.113"></a>
<FONT color="green">114</FONT>                    statement.execute(sql);<a name="line.114"></a>
<FONT color="green">115</FONT>                } catch (SQLException e) {<a name="line.115"></a>
<FONT color="green">116</FONT>                    this.log.error("SQL statement failed: " + sql, e);<a name="line.116"></a>
<FONT color="green">117</FONT>                    throw e;<a name="line.117"></a>
<FONT color="green">118</FONT>                } finally {<a name="line.118"></a>
<FONT color="green">119</FONT>                    statement.close();<a name="line.119"></a>
<FONT color="green">120</FONT>                }<a name="line.120"></a>
<FONT color="green">121</FONT>            }<a name="line.121"></a>
<FONT color="green">122</FONT>        }<a name="line.122"></a>
<FONT color="green">123</FONT>    }<a name="line.123"></a>
<FONT color="green">124</FONT>    <a name="line.124"></a>




























































</PRE>
</BODY>
</HTML>
